Skip to content
This repository has been archived by the owner on May 3, 2018. It is now read-only.

uri-templates/uritemplate-py

Repository files navigation

This repo has been archived; see https://github.com/python-hyper/uritemplate for its replacement.

uritemplate

build status

This is a Python implementation of RFC6570, URI Template, and can expand templates up to and including Level 4 in that specification.

It exposes a method, expand. For example:

>>> from uritemplate import expand
>>> expand("http://www.{domain}/", {"domain": "foo.com"})
'http://www.foo.com/'

It also exposes a method variables that returns all variables used in a uritemplate. For example:

>>> from uritemplate import variables
>>> variables('http:www{.domain*}{/top,next}{?q:20}')
>>> set(['domain', 'next', 'q', 'top'])

This function can be useful to determine what keywords are available to be expanded.

Requirements

uritemplate works with Python 2.5+.

Note

You need to install simplejson module to run the tests on Python 2.5.

Install

The easiest way to install uritemplate is with pip:

$ pip install uritemplate

See its Python Package Index entry for more.

License

Copyright 2011-2013 Joe Gregorio

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.